Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check Too: Update validation messages #777

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rosado
Copy link
Collaborator

@rosado rosado commented Jan 14, 2025

What type of PR is this? (check all applicable)

  • Refactor

Description

A few validation messages were updated. No changes in behaviour.

Related Tickets & Documents

Closes #712

QA Instructions, Screenshots, Recordings

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

  • Yes

QA sign off

  • Code has been checked and approved
  • Design has been checked and approved
  • Product and business logic has been checked and proved

[optional] Are there any post-deployment tasks we need to perform?

[optional] Are there any dependencies on other PRs or Work?

Summary by CodeRabbit

  • Bug Fixes

    • Improved validation error messages for various form fields
    • Enhanced user guidance for:
      • Datafile upload
      • URL validation
      • Endpoint URL format
      • Required field notifications
  • Documentation

    • Updated error messages to provide clearer, more specific instructions for users when encountering validation errors

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

The pull request focuses on updating validation messages in the validationMessageLookup.js file and corresponding test case. The changes aim to improve user guidance by providing more specific and helpful error messages for various validation scenarios, including file upload, URL validation, and endpoint URL formatting. The modifications enhance the clarity of feedback for users when encountering validation errors, making the error messages more informative and actionable.

Changes

File Change Summary
src/filters/validationMessageLookup.js Updated validation messages for:
- Datafile field (mime type error)
- URL existence check
- Service connection error
- Endpoint URL format
test/unit/dataset-details.test.js Updated error message test for endpoint URL validation

Assessment against linked issues

Objective Addressed Explanation
Update validation message content [#712]
Improve user guidance for file/URL validation

Possibly related PRs

Suggested reviewers

  • GeorgeGoodall-GovUk
  • DilwoarH

Poem

🐰 Validation messages, once so plain,
Now shine bright with knowledge's refrain!
Clearer guidance, errors more kind,
Helping users leave confusion behind.
A rabbit's wisdom in each line we write! 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Jan 14, 2025

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 69.04% 5421 / 7851
🔵 Statements 69.04% 5421 / 7851
🔵 Functions 67.18% 215 / 320
🔵 Branches 81.66% 686 / 840
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/filters/validationMessageLookup.js 100% 100% 100% 100%
Generated in workflow #617 for commit 699b62f by the Vitest Coverage Report Action

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/filters/validationMessageLookup.js (2)

25-25: Consider using British English spelling for 'recognised'.

The validation message is clear and actionable. However, to maintain consistency with British English, consider changing "recognized" to "recognised".

-    mimeTypeMalformed: 'The selected file has a malformed mime type and is not recognised. Try creating a new version and uploading again, or contact your server administrator for support'
+    mimeTypeMalformed: 'The selected file has a malformed mime type and is not recognised. Try creating a new version and uploading again, or contact your server administrator for support'

50-50: Consider standardising URL format messages across fields.

While the message is clear, notice that the documentation-url field uses a different format message style. Consider standardising the format messages across all URL fields for consistency.

-    format: 'Enter a valid documentation URL',
+    format: 'Documentation URL must start with http:// or https://, have no spaces or unusual characters like { } [ ]',
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d7c5c0 and eeaac75.

📒 Files selected for processing (2)
  • src/filters/validationMessageLookup.js (2 hunks)
  • test/unit/dataset-details.test.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: run-tests / test
🔇 Additional comments (3)
src/filters/validationMessageLookup.js (2)

31-31: LGTM! Clear and well-formatted message.

The message follows GOV.UK style guidelines and uses proper punctuation.


36-36: LGTM! Follows GOV.UK error message pattern.

The message appropriately communicates the service error and provides a clear next step.

test/unit/dataset-details.test.js (1)

82-82: LGTM! Test correctly updated to match new validation message.

The test expectation has been properly aligned with the updated validation message from validationMessageLookup.js.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update check validation message content
2 participants